dxp-ux

(0 reviews)

List BillingAccount (TMF666)

This retrieves a billing account information used by:

identityType & identityNumber or locationId for PR.
serviceNumber for PA.

URL

http://[localhost]:[port]/dxp-ux/v1/{businessId}/billingAccount

URL PARAMS

name	type	description	required
businessId	String	2 letter ISO 3166 country code (TT, BB, JM, PA, PR etc.) identifying the business unit. Expected one is "PR"-Puerto Rico and ''PA" -Panama	Y

Headers

name	type	description	required
client_id	string	The client_id identifying the channel. Minimum characters: 5	Y
client_secret	string	Password associated with the client_id. Minimum characters: 5	Y
x-tax-identifier	string	Tax identifier value/ SSN. This is encrypted value.	N
channelId	string	Channel to identify the business group. Can be: "APP"	Y(PR), N(PA)
X-Correlation-ID	string	An identifier for the current call chain that can be used to tie together log entries on multiple layers (e.g. client, server, mainframe). This identifier must be designed to be unique across all applications. Pattern: ^[a-zA-Z0-9-+/=_]{16,64}$ Minimum characters: 16 Maximum characters: 64	N
lob	String	Enum: PREPAID, POSTPAID,FIXED	N

Note: To retrieve PR debtCheck details based on SSN need to pass "x-tax-identifier".

Query Params

name	type	description	required (mandatory-Y, optional-N, Not applicable- N/A)
identityType	String	Describes the type of the id. Example: "SSN"	N/A(PA) Y(PR)
balanceCheck	Boolean	Flag for customer account debt information. API will return customer accounts balance if this flag is true.	N/A(PA) N(PR)
locationId	String	Location Id is used to fetch account debt using address id.	N/A(PA) Y(PR)
identityNumber	String	Personal Identification code/value	N/A(PA) Y(PR)
characteristic.name	String	Name of the characteristic. Here it is "ServiceId" for PA.	Y(PA) N/A(PR)
characteristic.value	String	Value of the characteristic. Example: 69877235	Y(PA) N/A(PR)

Note: To retrieve PR debtCheck details either "locationId" or "identityType" and "identityNumber" are required. To Fetch the response based on Location ID need to pass "locationId".

Data Model - Response

name	type	description	required (mandatory-Y, optional-N, Not applicable- N/A)
id	String	Unique identifier of the account	Y (PA)
href	String	Unique reference of the account	Y(PA)
lastModified	string	Date of last modification of the account	N (PA)
name	String	Name of the account	Y (PA)
@type	String	When sub-classing, this defines the sub-class entity name	Y (PA)
state	String	Contains the lifecycle state such as: Active, Closed, Suspended and so on	Y (PA)
characteristic[]	array	A list of characteristics that characterize this billingAccount	Y (PA)
characteristic.name	String	Name of the characteristic For PA, it is "ServiceId"	Y (PA)
characteristic.value	String	value of the characteristic For PA, it is serviceNumber	Y (PA)

Expected values for CSG FIXED Auto Pay

Field Name	Description
paymentStatus	blank - Active or Normal S - Suspended B - Balance is less than EFT minimum debit amount D - Debit Error E - Prenote Error G - EFT debit had been sent to ACH processor P - Prenote Error W - Waiting

Key considerations

PA Implementation:

Please refer the response from following URL: DXP-UX API - ListBillingAccount

1. This is implemented for POSTPAID and FIXED customers.
2. This provides basic information like AccountNumber, AccountName and State for the provided serviceNumber.
3. Possible values for state:
       A - Allocated but not yet active
       B - Call Barred
    C - Ceased
    D - In default but not on TOS
    E - Written off
    F - Closed
    O - Debt Outsource
    P - In default but promise to pay
    S - Recommended for cessation
    T - Tossed
    W - Working
4. For all the dateTime fields
  - Any datetime before 1908-04-22 will show offset -05:18
  - Any datetime on or after 1908-04-22 will show offset -05:00